<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">











<html xmlns="http://www.w3.org/1999/xhtml">
  <head>
    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
    <title>Maven Storyteller Plugin - storyteller:export-dependency-graph</title>
    <style type="text/css" media="all">
      @import url("./css/maven-base.css");
      @import url("./css/maven-theme.css");
      @import url("./css/site.css");
    </style>
    <link rel="stylesheet" href="./css/print.css" type="text/css" media="print" />
          </head>
  <body class="composite">
    <div id="banner">
                    <span id="bannerLeft">
    
            Maven Storyteller Plugin
    
            </span>
                    <div class="clear">
        <hr/>
      </div>
    </div>
    <div id="breadcrumbs">
          
  

  
    
  
  
    
            <div class="xleft">
        Last Published: 2011-02-14
                      </div>
            <div class="xright">            <a href="http://static.highsource.org/storyteller/plugin" class="externalLink">Maven Storyteller Plugin</a>
            
  

  
    
  
  
    
  </div>
      <div class="clear">
        <hr/>
      </div>
    </div>
    <div id="leftColumn">
      <div id="navcolumn">
           
  

  
    
  
  
    
                             <h5>Project Documentation</h5>
            <ul>
              
                
              
      
            
      
            
      
            
      
            
      
            
      
            
      
            
      
            
      
            
      
            
      
              
        <li class="collapsed">
                    <a href="project-info.html">Project Information</a>
                </li>
              
                
              
      
              
        <li class="collapsed">
                    <a href="project-reports.html">Project Reports</a>
                </li>
          </ul>
                                           <a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy">
            <img alt="Built by Maven" src="./images/logos/maven-feather.png"></img>
          </a>
                       
  

  
    
  
  
    
        </div>
    </div>
    <div id="bodyColumn">
      <div id="contentBox">
        <div class="section"><h2><a name="storyteller:export-dependency-graph"></a>storyteller:export-dependency-graph</h2>
<p><strong>Full name</strong>:</p>
<p>org.highsource.storyteller:maven-storyteller-plugin:0.2-SNAPSHOT:export-dependency-graph</p>
<p><strong>Description</strong>:</p>
<div>Export the dependency graph of the current project, or of a
specified artifact.</div><p><strong>Attributes</strong>:</p>
<ul><li>Requires dependency resolution of artifacts in scope: <code>test</code>.</li>
<li>Binds by default to the lifecycle phase: <code>verify</code>.</li>
</ul>
<div class="section"><h3><a name="Required_Parameters"></a>Required Parameters</h3>
<table class="bodyTable"><tr class="a"><th>Name</th>
<th>Type</th>
<th>Since</th>
<th>Description</th>
</tr>
<tr class="b"><td><strong><a href="#file">file</a></strong></td>
<td><code>File</code></td>
<td><code>-</code></td>
<td>File to export the dependency graph to. Format of the exported
graph will be inferred from the file's extension. (choose from:
pdf, png, dot, gml, graphml)<br />
<strong>Default value is</strong>: <code>dependencies.graphml</code>.</td>
</tr>
</table>
</div>
<div class="section"><h3><a name="Optional_Parameters"></a>Optional Parameters</h3>
<table class="bodyTable"><tr class="a"><th>Name</th>
<th>Type</th>
<th>Since</th>
<th>Description</th>
</tr>
<tr class="b"><td><strong><a href="#artifactId">artifactId</a></strong></td>
<td><code>String</code></td>
<td><code>-</code></td>
<td>(no description)<br />
</td>
</tr>
<tr class="a"><td><strong><a href="#batikHints">batikHints</a></strong></td>
<td><code>Map</code></td>
<td><code>-</code></td>
<td>Hints to pass to Batik when rendering.<br />
</td>
</tr>
<tr class="b"><td><strong><a href="#classifier">classifier</a></strong></td>
<td><code>String</code></td>
<td><code>-</code></td>
<td>(no description)<br />
</td>
</tr>
<tr class="a"><td><strong><a href="#graphVizDotFile">graphVizDotFile</a></strong></td>
<td><code>String</code></td>
<td><code>-</code></td>
<td>The plugin uses GraphViz package to render graphs in formats like
PDF and so on. If the <code>dot</code> executable is not in PATH,
it can be specified manually here.<br />
<strong>Default value is</strong>: <code>dot</code>.</td>
</tr>
<tr class="b"><td><strong><a href="#groupId">groupId</a></strong></td>
<td><code>String</code></td>
<td><code>-</code></td>
<td>(no description)<br />
</td>
</tr>
<tr class="a"><td><strong><a href="#repositoryId">repositoryId</a></strong></td>
<td><code>String</code></td>
<td><code>-</code></td>
<td>(no description)<br />
<strong>Default value is</strong>: <code>default</code>.</td>
</tr>
<tr class="b"><td><strong><a href="#repositoryLayout">repositoryLayout</a></strong></td>
<td><code>String</code></td>
<td><code>-</code></td>
<td>(no description)<br />
</td>
</tr>
<tr class="a"><td><strong><a href="#repositoryURL">repositoryURL</a></strong></td>
<td><code>String</code></td>
<td><code>-</code></td>
<td>(no description)<br />
</td>
</tr>
<tr class="b"><td><strong><a href="#type">type</a></strong></td>
<td><code>String</code></td>
<td><code>-</code></td>
<td>(no description)<br />
<strong>Default value is</strong>: <code>jar</code>.</td>
</tr>
<tr class="a"><td><strong><a href="#useBatik">useBatik</a></strong></td>
<td><code>boolean</code></td>
<td><code>-</code></td>
<td>Use Batik to render PNGs instead of Graphviz's default renderer.<br />
<strong>Default value is</strong>: <code>false</code>.</td>
</tr>
<tr class="b"><td><strong><a href="#version">version</a></strong></td>
<td><code>String</code></td>
<td><code>-</code></td>
<td>(no description)<br />
</td>
</tr>
</table>
</div>
<div class="section"><h3><a name="Parameter_Details"></a>Parameter Details</h3>
<p><strong><a name="artifactId">artifactId</a>:</strong></p>
<div>(no description)</div><ul><li><strong>Type</strong>: <code>java.lang.String</code></li>
<li><strong>Required</strong>: <code>No</code></li>
<li><strong>Expression</strong>: <code>${artifactId}</code></li>
</ul>
<hr />
<p><strong><a name="batikHints">batikHints</a>:</strong></p>
<div>Hints to pass to Batik when rendering.</div><ul><li><strong>Type</strong>: <code>java.util.Map</code></li>
<li><strong>Required</strong>: <code>No</code></li>
</ul>
<hr />
<p><strong><a name="classifier">classifier</a>:</strong></p>
<div>(no description)</div><ul><li><strong>Type</strong>: <code>java.lang.String</code></li>
<li><strong>Required</strong>: <code>No</code></li>
<li><strong>Expression</strong>: <code>${classifier}</code></li>
</ul>
<hr />
<p><strong><a name="file">file</a>:</strong></p>
<div>File to export the dependency graph to. Format of the exported
graph will be inferred from the file's extension. (choose from:
pdf, png, dot, gml, graphml)</div><ul><li><strong>Type</strong>: <code>java.io.File</code></li>
<li><strong>Required</strong>: <code>Yes</code></li>
<li><strong>Expression</strong>: <code>${file}</code></li>
<li><strong>Default</strong>: <code>dependencies.graphml</code></li>
</ul>
<hr />
<p><strong><a name="graphVizDotFile">graphVizDotFile</a>:</strong></p>
<div>The plugin uses GraphViz package to render graphs in formats like
PDF and so on. If the <code>dot</code> executable is not in PATH,
it can be specified manually here.</div><ul><li><strong>Type</strong>: <code>java.lang.String</code></li>
<li><strong>Required</strong>: <code>No</code></li>
<li><strong>Expression</strong>: <code>${graphViz.dotFile}</code></li>
<li><strong>Default</strong>: <code>dot</code></li>
</ul>
<hr />
<p><strong><a name="groupId">groupId</a>:</strong></p>
<div>(no description)</div><ul><li><strong>Type</strong>: <code>java.lang.String</code></li>
<li><strong>Required</strong>: <code>No</code></li>
<li><strong>Expression</strong>: <code>${groupId}</code></li>
</ul>
<hr />
<p><strong><a name="repositoryId">repositoryId</a>:</strong></p>
<div>(no description)</div><ul><li><strong>Type</strong>: <code>java.lang.String</code></li>
<li><strong>Required</strong>: <code>No</code></li>
<li><strong>Expression</strong>: <code>${repositoryId}</code></li>
<li><strong>Default</strong>: <code>default</code></li>
</ul>
<hr />
<p><strong><a name="repositoryLayout">repositoryLayout</a>:</strong></p>
<div>(no description)</div><ul><li><strong>Type</strong>: <code>java.lang.String</code></li>
<li><strong>Required</strong>: <code>No</code></li>
<li><strong>Expression</strong>: <code>${repositoryLayout}</code></li>
</ul>
<hr />
<p><strong><a name="repositoryURL">repositoryURL</a>:</strong></p>
<div>(no description)</div><ul><li><strong>Type</strong>: <code>java.lang.String</code></li>
<li><strong>Required</strong>: <code>No</code></li>
<li><strong>Expression</strong>: <code>${repositoryURL}</code></li>
</ul>
<hr />
<p><strong><a name="type">type</a>:</strong></p>
<div>(no description)</div><ul><li><strong>Type</strong>: <code>java.lang.String</code></li>
<li><strong>Required</strong>: <code>No</code></li>
<li><strong>Expression</strong>: <code>${type}</code></li>
<li><strong>Default</strong>: <code>jar</code></li>
</ul>
<hr />
<p><strong><a name="useBatik">useBatik</a>:</strong></p>
<div>Use Batik to render PNGs instead of Graphviz's default renderer.</div><ul><li><strong>Type</strong>: <code>boolean</code></li>
<li><strong>Required</strong>: <code>No</code></li>
<li><strong>Expression</strong>: <code>${useBatik}</code></li>
<li><strong>Default</strong>: <code>false</code></li>
</ul>
<hr />
<p><strong><a name="version">version</a>:</strong></p>
<div>(no description)</div><ul><li><strong>Type</strong>: <code>java.lang.String</code></li>
<li><strong>Required</strong>: <code>No</code></li>
<li><strong>Expression</strong>: <code>${version}</code></li>
</ul>
</div>
</div>

      </div>
    </div>
    <div class="clear">
      <hr/>
    </div>
    <div id="footer">
      <div class="xright">&#169;  
          2011
    
          
  

  
    
  
  
    
  </div>
      <div class="clear">
        <hr/>
      </div>
    </div>
  </body>
</html>
